Namespaces

Classes

Static Service Container wrapper.

Functions

bool
_layout_builder_bundle_has_no_layouts(string $entity_type_id, string $bundle)

Determines if there are zero layout overrides for the bundle.

bool
_layout_builder_bundle_has_no_translations(string $entity_type_id, string $bundle)

Determines if there are zero translations for the bundle.

bool
_menu_link_content_post_update_make_menu_link_content_revisionable__fix_default_langcode(array $sandbox)
internal

Fixes recoverable data integrity issues in the "default_langcode" field.

bool
_taxonomy_post_update_make_taxonomy_term_revisionable__fix_default_langcode(array $sandbox)
internal

Fixes recoverable data integrity issues in the "default_langcode" field.

action_post_update_move_plugins($sandbox = NULL)

Moves action plugins to core.

action_post_update_remove_settings()

Removes action settings.

bool
authorize_access_allowed(Request $request)

Determines if the current user is allowed to run authorize.php.

block_content_post_update_add_views_reusable_filter($sandbox = NULL)

Adds a 'reusable' filter to all Custom Block views.

block_content_removed_post_updates()

Implements hook_removed_post_updates().

block_post_update_disable_blocks_with_missing_contexts()

Disable all blocks with missing context IDs in block_update_8001().

block_post_update_disabled_region_update()

Disable blocks that are placed into the "disabled" region.

block_post_update_fix_negate_in_conditions()

Fix invalid 'negate' values in block visibility conditions.

block_post_update_replace_node_type_condition()

Updates the node type visibility condition.

block_removed_post_updates()

Implements hook_removed_post_updates().

array
callback_allowed_values_function(FieldStorageDefinitionInterface $definition, FieldableEntityInterface $entity = NULL, bool $cacheable = TRUE)

Provide the allowed values for a 'list_*' field.

callback_batch_finished($success, $results, $operations)

Complete a batch process.

callback_batch_operation($multiple_params, array|ArrayAccess $context)

Perform a single batch operation.

comment_post_update_add_ip_address_setting()

Add comment settings.

comment_post_update_enable_comment_admin_view()

Enable the comment admin view.

comment_removed_post_updates()

Implements hook_removed_post_updates().

contact_post_update_add_message_redirect_field_to_contact_form()

Initialize 'message' and 'redirect' field values to 'contact_form' entities.

contact_removed_post_updates()

Implements hook_removed_post_updates().

content_moderation_post_update_entity_display_dependencies($sandbox)

Update the dependencies of entity displays to include associated workflow.

content_moderation_post_update_set_default_moderation_state($sandbox)

Set the default moderation state for new content to 'draft'.

content_moderation_post_update_set_views_filter_latest_translation_affected_revision($sandbox)

Set the filter on the moderation view to be the latest translation affected.

content_moderation_post_update_update_cms_default_revisions($sandbox)

Synchronize moderation state default revisions with their host entities.

content_moderation_post_update_views_field_plugin_id($sandbox)

Update the moderation state views field plugin ID.

content_moderation_removed_post_updates()

Implements hook_removed_post_updates().

contextual_post_update_fixed_endpoint_and_markup()

Ensure new page loads use the updated JS and get the updated markup.

contextual_removed_post_updates()

Implements hook_removed_post_updates().

datetime_range_post_update_translatable_separator()

Clear caches to ensure schema changes are read.

datetime_range_post_update_views_string_plugin_id()

Update existing views using datetime_range fields.

datetime_range_removed_post_updates()

Implements hook_removed_post_updates().

dblog_post_update_convert_recent_messages_to_view()

Replace 'Recent log messages' with a view.

dblog_removed_post_updates()

Implements hook_removed_post_updates().

drupal_migrate_post_update_clear_migrate_field_plugin_cache()

Force MigrateField plugin definitions to be cleared.

editor_post_update_clear_cache_for_file_reference_filter()

Clear the render cache to fix file references added by Editor.

editor_removed_post_updates()

Implements hook_removed_post_updates().

field_post_update_email_widget_size_setting()

Adds the 'size' setting for email widgets.

field_post_update_entity_reference_handler_setting()

Fixes the 'handler' setting for entity reference fields.

field_post_update_remove_handler_submit_setting()

Remove the stale 'handler_submit' setting for entity_reference fields.

field_post_update_save_custom_storage_property()

Re-save all field storage config objects to add 'custom_storage' property.

field_removed_post_updates()

Implements hook_removed_post_updates().

file_post_update_add_txt_if_allows_insecure_extensions($sandbox = NULL)

Add txt to allowed extensions for all fields that allow uploads of insecure files.

hal_post_update_delete_settings()

Remove obsolete hal.settings configuration key.

hook_ENTITY_TYPE_access(EntityInterface $entity, string $operation, AccountInterface $account)

Control entity operation access for a specific entity type.

hook_ENTITY_TYPE_build_defaults_alter(array $build, EntityInterface $entity, string $view_mode)

Alter entity renderable values before cache checking in drupal_render().

hook_ENTITY_TYPE_create(EntityInterface $entity)

Acts when creating a new entity of a specific type.

hook_ENTITY_TYPE_create_access(AccountInterface $account, array $context, string $entity_bundle)

Control entity create access for a specific entity type.

hook_ENTITY_TYPE_delete(EntityInterface $entity)

Respond to entity deletion of a particular type.

hook_ENTITY_TYPE_field_values_init(FieldableEntityInterface $entity)

Acts when initializing a fieldable entity object.

hook_ENTITY_TYPE_insert(EntityInterface $entity)

Respond to creation of a new entity of a particular type.

hook_ENTITY_TYPE_load(array $entities)

Act on entities of a specific type when loaded.

hook_ENTITY_TYPE_predelete(EntityInterface $entity)

Act before entity deletion of a particular entity type.

hook_ENTITY_TYPE_prepare_form(EntityInterface $entity, $operation, FormStateInterface $form_state)

Acts on a particular type of entity object about to be in an entity form.

hook_ENTITY_TYPE_presave(EntityInterface $entity)

Act on a specific type of entity before it is created or updated.

hook_ENTITY_TYPE_revision_create(EntityInterface $new_revision, EntityInterface $entity, bool|null $keep_untranslatable_fields)

Respond to entity revision creation.

hook_ENTITY_TYPE_revision_delete(EntityInterface $entity)

Respond to entity revision deletion of a particular type.

hook_ENTITY_TYPE_storage_load(array $entities)

Act on content entities of a given type when loaded from the storage.

hook_ENTITY_TYPE_translation_create(EntityInterface $translation)

Acts when creating a new entity translation of a specific type.

hook_ENTITY_TYPE_translation_delete(EntityInterface $translation)

Respond to entity translation deletion of a particular type.

hook_ENTITY_TYPE_translation_insert(EntityInterface $translation)

Respond to creation of a new entity translation of a particular type.

hook_ENTITY_TYPE_update(EntityInterface $entity)

Respond to updates to an entity of a particular type.

hook_ENTITY_TYPE_view(array $build, EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode)

Act on entities of a particular type being assembled before rendering.

hook_ENTITY_TYPE_view_alter(array $build, EntityInterface $entity, EntityViewDisplayInterface $display)

Alter the results of the entity build array for a particular entity type.

hook_aggregator_fetcher_info_alter(array $info)

Perform alterations on the available fetchers.

hook_aggregator_parser_info_alter(array $info)

Perform alterations on the available parsers.

hook_aggregator_processor_info_alter(array $info)

Perform alterations on the available processors.

hook_ajax_render_alter(array $data)

Alter the Ajax command data that is sent to the client.

hook_archiver_info_alter($info)

Alter archiver information declared by other modules.

hook_batch_alter($batch)

Alter batch information before a batch is processed.

hook_block_access(Block $block, string $operation, AccountInterface $account)

Control access to a block instance.

hook_block_alter(array[] $definitions)

Allow modules to alter the block plugin definitions.

hook_block_build_BASE_BLOCK_ID_alter(array $build, BlockPluginInterface $block)

Provide a block plugin specific block_build alteration.

hook_block_build_alter(array $build, BlockPluginInterface $block)

Alter the result of \Drupal\Core\Block\BlockBase::build().

hook_block_view_BASE_BLOCK_ID_alter(array $build, BlockPluginInterface $block)

Provide a block plugin specific block_view alteration.

hook_block_view_alter(array $build, BlockPluginInterface $block)

Alter the result of \Drupal\Core\Block\BlockBase::build().

hook_cache_flush()

Flush all persistent and static caches.

void
hook_ckeditor4to5upgrade_plugin_info_alter(array $plugin_definitions)

Modify the list of available CKEditor 4 to 5 Upgrade plugins.

void
hook_ckeditor5_plugin_info_alter(array $plugin_definitions)

Modify the list of available CKEditor 5 plugins.

hook_ckeditor_css_alter(array $css, Editor $editor)

Modify the list of CSS files that will be added to a CKEditor instance.

hook_ckeditor_plugin_info_alter(array $plugins)

Modify the list of available CKEditor plugins.

hook_config_import_steps_alter(array $sync_steps, ConfigImporter $config_importer)

Alter the configuration synchronization steps.

hook_config_schema_info_alter($definitions)

Alter config typed data definitions.

hook_config_translation_info(array $info)

Introduce dynamic translation tabs for translation of configuration.

hook_config_translation_info_alter(array $info)

Alter existing translation tabs for translation of configuration.

hook_countries_alter($countries)

Alter the default country list.

hook_cron()

Perform periodic actions.

hook_css_alter($css, AttachedAssetsInterface $assets)

Alter CSS files before they are output on the page.

hook_data_type_info_alter(array $data_types)

Alter available data types for typed data wrappers.

hook_display_variant_plugin_alter(array $definitions)

Alter display variant plugin definitions.

hook_editor_info_alter(array $editors)

Performs alterations on text editor definitions.

hook_editor_js_settings_alter(array $settings)

Modifies JavaScript settings that are added for text editors.

hook_editor_xss_filter_alter(string $editor_xss_filter_class, FilterFormatInterface $format, FilterFormatInterface $original_format = NULL)

Modifies the text editor XSS filter that will used for the given text format.

hook_element_info_alter(array $info)

Alter the element type information returned from modules.

hook_element_plugin_alter(array $definitions)

Alter Element plugin definitions.

hook_entity_access(EntityInterface $entity, string $operation, AccountInterface $account)

Control entity operation access.

hook_entity_base_field_info(EntityTypeInterface $entity_type)

Provides custom base field definitions for a content entity type.

hook_entity_base_field_info_alter(FieldDefinitionInterface[] $fields, EntityTypeInterface $entity_type)

Alter base field definitions for a content entity type.

hook_entity_build_defaults_alter(array $build, EntityInterface $entity, string $view_mode)

Alter entity renderable values before cache checking in drupal_render().

hook_entity_bundle_create(string $entity_type_id, string $bundle)

Act on entity_bundle_create().

hook_entity_bundle_delete(string $entity_type_id, string $bundle)

Act on entity_bundle_delete().

hook_entity_bundle_field_info(EntityTypeInterface $entity_type, string $bundle, array $base_field_definitions)

Provides field definitions for a specific bundle within an entity type.

hook_entity_bundle_field_info_alter(FieldDefinitionInterface[] $fields, EntityTypeInterface $entity_type, string $bundle)

Alter bundle field definitions.

array
hook_entity_bundle_info()

Describe the bundles for entity types.

hook_entity_bundle_info_alter(array $bundles)

Alter the bundles for entity types.

hook_entity_create(EntityInterface $entity)

Acts when creating a new entity.

hook_entity_create_access(AccountInterface $account, array $context, string $entity_bundle)

Control entity create access.

hook_entity_delete(EntityInterface $entity)

Respond to entity deletion.

hook_entity_display_build_alter(array $build, array $context)

Alter the render array generated by an EntityDisplay for an entity.

array
hook_entity_extra_field_info()

Exposes "pseudo-field" components on content entities.

hook_entity_extra_field_info_alter(array $info)

Alter "pseudo-field" components on content entities.

hook_entity_field_access(string $operation, FieldDefinitionInterface $field_definition, AccountInterface $account, FieldItemListInterface $items = NULL)

Control access to fields.

hook_entity_field_access_alter(array $grants, array $context)

Alter the default access behavior for a given field.

hook_entity_field_storage_info(EntityTypeInterface $entity_type)

Provides field storage definitions for a content entity type.

hook_entity_field_storage_info_alter(FieldStorageDefinitionInterface[] $fields, EntityTypeInterface $entity_type)

Alter field storage definitions for a content entity type.

hook_entity_field_values_init(FieldableEntityInterface $entity)

Acts when initializing a fieldable entity object.

hook_entity_form_display_alter(EntityFormDisplayInterface $form_display, array $context)

Alter the settings used for displaying an entity form.

hook_entity_form_mode_alter(string $form_mode, EntityInterface $entity)

Change the form mode used to build an entity form.

hook_entity_insert(EntityInterface $entity)

Respond to creation of a new entity.

hook_entity_load(array $entities, string $entity_type_id)

Act on entities when loaded.

array
hook_entity_operation(EntityInterface $entity)

Declares entity operations.

hook_entity_operation_alter(array $operations, EntityInterface $entity)

Alter entity operations.

hook_entity_predelete(EntityInterface $entity)

Act before entity deletion.

hook_entity_preload(array $ids, string $entity_type_id)

Act on an array of entity IDs before they are loaded.

hook_entity_prepare_form(EntityInterface $entity, $operation, FormStateInterface $form_state)

Acts on an entity object about to be shown on an entity form.

hook_entity_prepare_view(string $entity_type_id, array $entities, array $displays, string $view_mode)

Act on entities as they are being prepared for view.

hook_entity_presave(EntityInterface $entity)

Act on an entity before it is created or updated.

hook_entity_revision_create(EntityInterface $new_revision, EntityInterface $entity, bool|null $keep_untranslatable_fields)

Respond to entity revision creation.

hook_entity_revision_delete(EntityInterface $entity)

Respond to entity revision deletion.

hook_entity_storage_load(array $entities, string $entity_type)

Act on content entities when loaded from the storage.

hook_entity_translation_create(EntityInterface $translation)

Acts when creating a new entity translation.

hook_entity_translation_delete(EntityInterface $translation)

Respond to entity translation deletion.

hook_entity_translation_insert(EntityInterface $translation)

Respond to creation of a new entity translation.

hook_entity_type_alter(array $entity_types)

Alter the entity type definitions.

hook_entity_type_build(array $entity_types)

Add to entity type definitions.

hook_entity_update(EntityInterface $entity)

Respond to updates to an entity.

hook_entity_view(array $build, EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode)

Act on entities being assembled before rendering.

hook_entity_view_alter(array $build, EntityInterface $entity, EntityViewDisplayInterface $display)

Alter the results of the entity build array.

hook_entity_view_display_alter(EntityViewDisplayInterface $display, array $context)

Alter the settings used for displaying an entity.

hook_entity_view_mode_alter(string $view_mode, EntityInterface $entity, array $context)

Change the view mode of an entity that is being displayed.

hook_entity_view_mode_info_alter(array $view_modes)

Alter the view modes for entity types.

string
hook_extension()

Declare a template file extension to be used with a theme engine.

hook_field_formatter_info_alter(array $info)

Perform alterations on Field API formatter types.

hook_field_formatter_settings_summary_alter(array $summary, array $context)

Alters the field formatter settings summary.

array
hook_field_formatter_third_party_settings_form(FormatterInterface $plugin, FieldDefinitionInterface $field_definition, string $view_mode, array $form, FormStateInterface $form_state)

Allow modules to add settings to field formatters provided by other modules.

hook_field_info_alter($info)

Perform alterations on Field API field types.

int
hook_field_info_max_weight(string $entity_type, string $bundle, string $context, string $context_mode)

Returns the maximum weight for the entity components handled by the module.

hook_field_purge_field(FieldConfig $field)

Acts when a field is being purged.

hook_field_purge_field_storage(FieldStorageConfig $field_storage)

Acts when a field storage definition is being purged.

hook_field_storage_config_update_forbid(FieldStorageConfigInterface $field_storage, FieldStorageConfigInterface $prior_field_storage)

Forbid a field storage update from occurring.

hook_field_ui_preconfigured_options_alter(array $options, string $field_type)

Perform alterations on preconfigured field options.

array
hook_field_views_data(FieldStorageConfigInterface $field_storage)

Override the default Views data for a Field API field.

hook_field_views_data_alter(array $data, FieldStorageConfigInterface $field_storage)

Alter the Views data for a single Field API field.

hook_field_views_data_views_data_alter(array $data, FieldStorageConfigInterface $field)

Alter the Views data on a per field basis.

hook_field_widget_WIDGET_TYPE_form_alter($element, FormStateInterface $form_state, $context)

Alter widget forms for a specific widget provided by another module.

hook_field_widget_complete_WIDGET_TYPE_form_alter($field_widget_complete_form, FormStateInterface $form_state, $context)

Alter the complete form for a specific widget provided by other modules.

hook_field_widget_complete_form_alter($field_widget_complete_form, FormStateInterface $form_state, $context)

Alter the complete form for field widgets provided by other modules.

hook_field_widget_form_alter($element, FormStateInterface $form_state, $context)

Alter forms for field widgets provided by other modules.

hook_field_widget_info_alter(array $info)

Perform alterations on Field API widget types.

hook_field_widget_multivalue_WIDGET_TYPE_form_alter(array $elements, FormStateInterface $form_state, array $context)

Alter multi-value widget forms for a widget provided by another module.

hook_field_widget_multivalue_form_alter(array $elements, FormStateInterface $form_state, array $context)

Alter forms for multi-value field widgets provided by other modules.

hook_field_widget_settings_summary_alter(array $summary, array $context)

Alters the field widget settings summary.

hook_field_widget_single_element_WIDGET_TYPE_form_alter(array $element, FormStateInterface $form_state, array $context)

Alter widget forms for a specific widget provided by another module.

hook_field_widget_single_element_form_alter(array $element, FormStateInterface $form_state, array $context)

Alter forms for field widgets provided by other modules.

array
hook_field_widget_third_party_settings_form(WidgetInterface $plugin, FieldDefinitionInterface $field_definition, string $form_mode, array $form, FormStateInterface $form_state)

Allow modules to add settings to field widgets provided by other modules.

hook_file_copy(FileInterface $file, FileInterface $source)

Respond to a file that has been copied.

If
hook_file_download($uri)

Control access to private file downloads and specify HTTP headers.

hook_file_mimetype_mapping_alter($mapping)

Alter MIME type mappings used to determine MIME type from a file extension.

hook_file_move(FileInterface $file, FileInterface $source)

Respond to a file that has been moved.

hook_file_url_alter($uri)

Alter the URL to a file.

array
hook_file_validate(FileInterface $file)

Check that files meet a given criteria.

array
hook_filetransfer_info()

Register information about FileTransfer classes provided by a module.

hook_filetransfer_info_alter(array $filetransfer_info)

Alter the FileTransfer class registry.

hook_filter_format_disable(FilterFormatInterface $format)

Perform actions when a text format has been disabled.

hook_filter_info_alter(array $info)

Perform alterations on filter definitions.

hook_filter_secure_image_alter(DOMElement $image)

Alters images with an invalid source.

hook_form_BASE_FORM_ID_alter($form, FormStateInterface $form_state, $form_id)

Provide a form-specific alteration for shared ('base') forms.

hook_form_FORM_ID_alter($form, FormStateInterface $form_state, $form_id)

Provide a form-specific alteration instead of the global hook_form_alter().

hook_form_alter($form, FormStateInterface $form_state, $form_id)

Perform alterations before a form is rendered.

hook_form_system_theme_settings_alter($form, FormStateInterface $form_state)

Allow themes to alter the theme-specific settings form.

hook_hal_relation_uri_alter(string $uri, array $context = [])

Alter the HAL relation URI.

hook_hal_type_uri_alter(string $uri, array $context = [])

Alter the HAL type URI.

string|array
hook_help(string $route_name, RouteMatchInterface $route_match)

Provide online user help.

hook_help_section_info_alter(array $info)

Perform alterations on help page section plugin definitions.

hook_help_topics_info_alter(array $info)
internal

Perform alterations on help topic definitions.

An
hook_hook_info()

Defines one or more hooks that are exposed by a module.

hook_image_effect_info_alter($effects)

Alter the information provided in \Drupal\image\Annotation\ImageEffect.

hook_image_style_flush(ImageStyleInterface $style)

Respond to image style flushing.

hook_install(bool $is_syncing)

Perform setup tasks when the module is installed.

array
hook_install_tasks(array $install_state)

Return an array of tasks to be performed by an installation profile.

hook_install_tasks_alter($tasks, $install_state)

Alter the full list of installation tasks.

hook_js_alter($javascript, AttachedAssetsInterface $assets)

Perform necessary alterations to the JavaScript before it is presented on the page.

hook_js_settings_alter(array $settings, AttachedAssetsInterface $assets)

Perform necessary alterations to the JavaScript settings (drupalSettings).

hook_js_settings_build(array $settings, AttachedAssetsInterface $assets)

Modify the JavaScript settings (drupalSettings).

hook_jsonapi_ENTITY_TYPE_filter_access(EntityTypeInterface $entity_type, AccountInterface $account)

Controls access to filtering by entity data via JSON:API.

hook_jsonapi_entity_field_filter_access(FieldDefinitionInterface $field_definition, AccountInterface $account)

Restricts filtering access to the given field.

hook_jsonapi_entity_filter_access(EntityTypeInterface $entity_type, AccountInterface $account)

Controls access when filtering by entity data via JSON:API.

hook_language_fallback_candidates_OPERATION_alter(array $candidates, array $context)

Allow modules to alter the fallback candidates for specific operations.

hook_language_fallback_candidates_alter(array $candidates, array $context)

Allow modules to alter the language fallback candidates.

hook_language_negotiation_info_alter(array $negotiation_info)

Perform alterations on language negotiation methods.

array
hook_language_types_info()

Define language types.

hook_language_types_info_alter(array $language_types)

Perform alterations on language types.

hook_layout_alter(LayoutDefinition[] $definitions)

Allow modules to alter layout plugin definitions.

hook_library_info_alter(array $libraries, string $extension)

Alter libraries provided by an extension.

array[]
hook_library_info_build()

Add dynamic library definitions.

hook_local_tasks_alter(array $local_tasks)

Alter local tasks plugins.

hook_locale_translation_projects_alter(array $projects)

Alter the list of projects to be updated by locale's interface translation.

hook_mail($key, $message, $params)

Prepares a message based on parameters;

hook_mail_alter($message)

Alter an email message created with MailManagerInterface->mail().

hook_mail_backend_info_alter(array $info)

Alter the list of mail backend plugin definitions.

hook_media_source_info_alter(array $sources)

Alters the information provided in \Drupal\media\Annotation\MediaSource.

hook_menu_local_actions_alter(array $local_actions)

Alter local actions plugins.

hook_menu_local_tasks_alter(array $data, string $route_name, RefinableCacheableDependencyInterface $cacheability)

Alter local tasks displayed on the page before they are rendered.

hook_migrate_MIGRATION_ID_prepare_row(Row $row, MigrateSourceInterface $source, MigrationInterface $migration)

Allows adding data to a row for a migration with the specified ID.

hook_migrate_prepare_row(Row $row, MigrateSourceInterface $source, MigrationInterface $migration)

Allows adding data to a row before processing it.

hook_migration_plugins_alter(array $migrations)

Allows altering the list of discovered migration plugins.

hook_module_implements_alter($implementations, $hook)

Alter the registry of modules implementing a hook.

hook_module_preinstall(string $module)

Perform necessary actions before a module is installed.

hook_module_preuninstall(string $module)

Perform necessary actions before a module is uninstalled.

hook_modules_installed($modules, bool $is_syncing)

Perform necessary actions after modules are installed.

hook_modules_uninstalled($modules, bool $is_syncing)

Perform necessary actions after modules are uninstalled.

An
hook_node_access_records(NodeInterface $node)

Set permissions for a node to be written to the database.

hook_node_access_records_alter(array $grants, NodeInterface $node)

Alter permissions for a node before it is written to the database.

array
hook_node_grants(AccountInterface $account, string $op)

Inform the node access system what permissions the user has.

hook_node_grants_alter(array $grants, AccountInterface $account, string $op)

Alter user access rules when trying to view, edit or delete a node.

array
hook_node_search_result(NodeInterface $node)

Act on a node being displayed as a search result.

string
hook_node_update_index(NodeInterface $node)

Act on a node being indexed for searching.

hook_oembed_resource_url_alter(array $parsed_url, Provider $provider)

Alters an oEmbed resource URL before it is fetched.

hook_options_list_alter(array $options, array $context)

Alters the list of options to be displayed for a field.

hook_page_attachments(array $attachments)

Add attachments (typically assets) to a page before it is rendered.

hook_page_attachments_alter(array $attachments)

Alter attachments (typically assets) to a page before it is rendered.

hook_page_bottom(array $page_bottom)

Add a renderable array to the bottom of the page.

hook_page_top(array $page_top)

Add a renderable array to the top of the page.

hook_path_delete(array $path)
deprecated

Respond to a path being deleted.

hook_path_insert(array $path)
deprecated

Respond to a path being inserted.

hook_path_update(array $path)
deprecated

Respond to a path being updated.

hook_plugin_filter_TYPE__CONSUMER_alter(array $definitions, array $extra)

Alter the filtering of plugin definitions for a specific type and consumer.

hook_plugin_filter_TYPE_alter(array $definitions, array $extra, string $consumer)

Alter the filtering of plugin definitions for a specific plugin type.

string|null
hook_post_update_NAME(array $sandbox)

Executes an update which is intended to update data, like entities.

hook_preprocess($variables, $hook)

Preprocess theme variables for templates.

hook_preprocess_HOOK($variables)

Preprocess theme variables for a specific theme hook.

hook_query_TAG_alter(AlterableInterface $query)

Perform alterations to a structured query for a given tag.

hook_query_alter(AlterableInterface $query)

Perform alterations to a structured query.

hook_queue_info_alter(array $queues)

Alter cron queue information before cron runs.

hook_quickedit_editor_alter(array $editors)

Allow modules to alter in-place editor plugin metadata.

A
hook_quickedit_render_field(EntityInterface $entity, string $field_name, string $view_mode_id, string $langcode)

Returns a renderable array for the value of a single field in an entity.

array
hook_ranking()

Provide additional methods of scoring for core search results for nodes.

string[]
hook_rdf_namespaces()

Allow modules to define namespaces for RDF mappings.

hook_rebuild()

Rebuild data based upon refreshed caches.

string[]
hook_removed_post_updates()

Return an array of removed hook_post_update_NAME() function names.

string
hook_render_template(string $template_file, array $variables)

Render a template using the theme engine.

An
hook_requirements($phase)

Check installation requirements and do status reporting.

hook_rest_relation_uri_alter(string $uri, array $context = [])
deprecated

Alter the REST relation URI.

hook_rest_resource_alter(array $definitions)

Alter the resource plugin definitions.

hook_rest_type_uri_alter(string $uri, array $context = [])
deprecated

Alter the REST type URI.

array
hook_schema()

Define the current version of the database schema.

hook_search_plugin_alter(array $definitions)

Alter search plugin definitions.

string
hook_search_preprocess(string $text, string|null $langcode = NULL)

Preprocess text for search.

string
hook_shortcut_default_set($account)

Return the name of a default shortcut set for the provided user account.

hook_simpletest_alter($groups)
deprecated

Alter the list of tests.

hook_system_breadcrumb_alter(Breadcrumb $breadcrumb, RouteMatchInterface $route_match, array $context)

Perform alterations to the breadcrumb built by the BreadcrumbManager.

hook_system_info_alter(array $info, Extension $file, string $type)

Alter the information parsed from module and theme .info.yml files.

hook_system_themes_page_alter($theme_groups)

Alters theme operation links.

hook_template_preprocess_default_variables_alter(array $variables)

Alter the default, hook-independent variables for all templates.

hook_test_finished($results)
deprecated

An individual test has finished.

hook_test_group_finished()
deprecated

A test group has finished.

hook_test_group_started()
deprecated

A test group has started.

array
hook_theme(array $existing, $type, $theme, $path)

Register a module or theme's theme implementations.

hook_theme_registry_alter($theme_registry)

Alter the theme registry information returned from hook_theme().

array
hook_theme_suggestions_HOOK(array $variables)

Provides alternate named suggestions for a specific theme hook.

hook_theme_suggestions_HOOK_alter(array $suggestions, array $variables)

Alters named suggestions for a specific theme hook.

array
hook_theme_suggestions_alter(array $suggestions, array $variables, string $hook)

Alters named suggestions for all theme hooks.

hook_themes_installed(array $theme_list)

Respond to themes being installed.

hook_themes_uninstalled(array $themes)

Respond to themes being uninstalled.

An
hook_token_info()

Provide information about available placeholder tokens and token types.

hook_token_info_alter($data)

Alter the metadata about available placeholder tokens and token types.

array
hook_tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata)

Provide replacement values for placeholder tokens.

hook_tokens_alter(array $replacements, array $context, BubbleableMetadata $bubbleable_metadata)

Alter replacement values for placeholder tokens.

An
hook_toolbar()

Add items to the toolbar menu.

hook_toolbar_alter($items)

Alter the toolbar menu after hook_toolbar() is invoked.

hook_tour_tips_alter(array $tour_tips, EntityInterface $entity)

Allow modules to alter tour items before render.

hook_tour_tips_info_alter(array $info)

Allow modules to alter tip plugin definitions.

hook_transliteration_overrides_alter(array $overrides, string $langcode)

Provide language-specific overrides for transliteration.

hook_uninstall(bool $is_syncing)

Remove any information that the module sets.

string|null
hook_update_N(array $sandbox)

Perform a single update between minor versions.

A
hook_update_dependencies()

Return an array of information about module update dependencies.

An
hook_update_last_removed()

Return a number which is no longer available as hook_update_N().

hook_update_projects_alter($projects)

Alter the list of projects before fetching data and comparing versions.

hook_update_status_alter($projects)

Alter the information about available updates for projects.

An
hook_updater_info()

Provide information on Updaters (classes that can update Drupal).

hook_updater_info_alter(array $updaters)

Alter the Updater information array.

hook_user_cancel(array $edit, UserInterface $account, string $method)

Act on user account cancellations.

hook_user_cancel_methods_alter(array $methods)

Modify account cancellation methods.

hook_user_format_name_alter(string|MarkupInterface $name, AccountInterface $account)

Alter the username that is displayed for a user.

hook_user_login(UserInterface $account)

The user just logged in.

hook_user_logout(AccountInterface $account)

The user just logged out.

hook_validation_constraint_alter(array $definitions)

Alter validation constraint plugin definitions.

If
hook_verify_update_archive(string $project, string $archive_file, string $directory)

Verify an archive after it has been downloaded and extracted.

array
hook_views_analyze(ViewExecutable $view)

Analyze a view to provide warnings about its configuration.

array
hook_views_data()

Describe data tables and fields (or the equivalent) to Views.

hook_views_data_alter(array $data)

Alter the table and field information from hook_views_data().

array
hook_views_form_substitutions()

Replace special strings when processing a view with form elements.

hook_views_invalidate_cache()

Allow modules to respond to the invalidation of the Views cache.

hook_views_plugins_access_alter(array $plugins)

Modify the list of available views access plugins.

hook_views_plugins_area_alter(array $plugins)

Modify the list of available views area handler plugins.

hook_views_plugins_argument_alter(array $plugins)

Modify the list of available views argument handler plugins.

hook_views_plugins_argument_default_alter(array $plugins)

Modify the list of available views default argument plugins.

hook_views_plugins_argument_validator_alter(array $plugins)

Modify the list of available views argument validation plugins.

hook_views_plugins_cache_alter(array $plugins)

Modify the list of available views cache plugins.

hook_views_plugins_display_alter(array $plugins)

Modify the list of available views display plugins.

hook_views_plugins_display_extenders_alter(array $plugins)

Modify the list of available views display extender plugins.

hook_views_plugins_exposed_form_alter(array $plugins)

Modify the list of available views exposed form plugins.

hook_views_plugins_field_alter(array $plugins)

Modify the list of available views field handler plugins.

hook_views_plugins_filter_alter(array $plugins)

Modify the list of available views filter handler plugins.

hook_views_plugins_join_alter(array $plugins)

Modify the list of available views join plugins.

hook_views_plugins_pager_alter(array $plugins)

Modify the list of available views pager plugins.

hook_views_plugins_query_alter(array $plugins)

Modify the list of available views query plugins.

hook_views_plugins_relationship_alter(array $plugins)

Modify the list of available views relationship handler plugins.

hook_views_plugins_row_alter(array $plugins)

Modify the list of available views row plugins.

hook_views_plugins_sort_alter(array $plugins)

Modify the list of available views sort handler plugins.

hook_views_plugins_style_alter(array $plugins)

Modify the list of available views style plugins.

hook_views_plugins_wizard_alter(array $plugins)

Modify the list of available views wizard plugins.

hook_views_post_build(ViewExecutable $view)

Act on the view immediately after the query is built.

hook_views_post_execute(ViewExecutable $view)

Act on the view immediately after the query has been executed.

hook_views_post_render(ViewExecutable $view, string $output, CachePluginBase $cache)

Post-process any rendered data.

hook_views_pre_build(ViewExecutable $view)

Act on the view before the query is built, but after displays are attached.

hook_views_pre_execute(ViewExecutable $view)

Act on the view after the query is built and just before it is executed.

hook_views_pre_render(ViewExecutable $view)

Act on the view immediately before rendering it.

hook_views_pre_view(ViewExecutable $view, string $display_id, array $args)

Alter a view at the very beginning of Views processing.

hook_views_preview_info_alter(array $rows, ViewExecutable $view)

Alter the view preview information.

hook_views_query_alter(ViewExecutable $view, QueryPluginBase $query)

Alter the query before it is executed.

array
hook_views_query_substitutions(ViewExecutable $view)

Replace special strings in the query before it is executed.

hook_views_ui_display_tab_alter(array[] $build, ViewUI $view, string $display_id)

Alter the renderable array representing the edit page for one display.

hook_views_ui_display_top_alter(array[] $build, ViewUI $view, string $display_id)

Alter the top of the display for the Views UI.

image_post_update_image_style_dependencies()

Saves the image style dependencies into form and view display entities.

image_post_update_scale_and_crop_effect_add_anchor($sandbox = NULL)

Add 'anchor' setting to 'Scale and crop' effects.

image_removed_post_updates()

Implements hook_removed_post_updates().

language_post_update_language_select_widget()

Add the 'include_locked' settings to the 'language_select' widget.

language_removed_post_updates()

Implements hook_removed_post_updates().

layout_builder_post_update_add_extra_fields($sandbox = NULL)

Ensure all extra fields are properly stored on entity view displays.

layout_builder_post_update_cancel_link_to_discard_changes_form()

Clear caches due to routing changes for the new discard changes form.

layout_builder_post_update_discover_blank_layout_plugin()

Clear caches to discover new blank layout plugin.

layout_builder_post_update_discover_new_contextual_links()

Clear caches due to new link added to Layout Builder's contextual links.

layout_builder_post_update_fix_tempstore_keys()

Fix Layout Builder tempstore keys of existing entries.

layout_builder_post_update_layout_builder_dependency_change()

Clear caches due to dependency changes in the layout_builder render element.

layout_builder_post_update_make_layout_untranslatable()

Set the layout builder field as non-translatable where possible.

layout_builder_post_update_override_entity_form_controller()

Clear caches due to addition of service decorator for entity form controller.

layout_builder_post_update_overrides_view_mode_annotation()

Clear caches due to changes to annotation changes to the Overrides plugin.

layout_builder_post_update_rebuild_plugin_dependencies($sandbox = NULL)

Rebuild plugin dependencies for all entity view displays.

layout_builder_post_update_remove_layout_is_rebuilding()

Clear caches due to the removal of the layout_is_rebuilding query string.

layout_builder_post_update_routing_defaults()

Clear caches due to routing changes to changing the URLs for defaults.

layout_builder_post_update_routing_entity_form()

Clear caches due to routing changes to move the Layout Builder UI to forms.

layout_builder_post_update_section_storage_context_definitions()

Clear caches due to changes to section storage annotation changes.

layout_builder_post_update_section_storage_context_mapping($sandbox = [])

Update view displays that use Layout Builder to add empty context mappings.

layout_builder_post_update_section_third_party_settings_schema()

Clear caches due to config schema additions.

layout_builder_post_update_tempstore_route_enhancer()

Clear caches due to adding a new route enhancer.

layout_builder_post_update_update_permissions()

Add new custom block permission to all roles with 'configure any layout'.

layout_builder_removed_post_updates()

Implements hook_removed_post_updates().

layout_discovery_post_update_recalculate_entity_form_display_dependencies($sandbox = NULL)

Recalculate dependencies for the entity_form_display entity.

layout_discovery_post_update_recalculate_entity_view_display_dependencies($sandbox = NULL)

Recalculate dependencies for the entity_view_display entity.

layout_discovery_removed_post_updates()

Implements hook_removed_post_updates().

locale_post_update_clear_cache_for_old_translations()

Clear cache to ensure plural translations are removed from it.

locale_removed_post_updates()

Implements hook_removed_post_updates().

media_library_post_update_add_buttons_to_page_view()

Add edit and delete button to media library view page display.

media_library_post_update_add_langcode_filters()

Add langcode filters to media library view displays.

media_library_post_update_add_media_library_image_style()

Create the 'media_library' image style if necessary.

media_library_post_update_add_status_extra_filter()

Add a status extra filter to the media library view default display.

media_library_post_update_default_administrative_list_to_table_display()

Sets /admin/content/media to the table display of the 'media' view.

media_library_post_update_display_modes()

Create and configure Media Library form and view displays for media types.

media_library_post_update_table_display()

Add a table display to the media library view and link grid/table displays.

media_library_post_update_update_8001_checkbox_classes()

Add non js prefixed classes to checkboxes if not present.

media_library_removed_post_updates()

Implements hook_removed_post_updates().

media_post_update_add_status_extra_filter()

Add a status extra filter to the media view default display.

media_post_update_collection_route()

Clear caches due to changes in local tasks and action links.

media_post_update_enable_standalone_url()

Keep media items viewable at /media/{id}.

media_post_update_modify_base_field_author_override()

Updates stale references to Drupal\media\Entity\Media::getCurrentUserId.

media_post_update_storage_handler()

Clear caches due to the addition of a Media-specific entity storage handler.

media_removed_post_updates()

Implements hook_removed_post_updates().

menu_link_content_post_update_make_menu_link_content_revisionable($sandbox)

Update custom menu links to be revisionable.

menu_link_content_removed_post_updates()

Implements hook_removed_post_updates().

migrate_drupal_post_update_uninstall_multilingual()

Uninstall migrate_drupal_multilingual since migrate_drupal is installed.

migrate_post_update_clear_migrate_source_count_cache()

Clear the source count cache.

node_post_update_configure_status_field_widget()

Load all form displays for nodes, add status with these settings, save.

node_post_update_glossary_view_published()

Add a published filter to the glossary View.

node_post_update_modify_base_field_author_override()

Updates stale references to Drupal\node\Entity\Node::getCurrentUserId.

node_post_update_node_revision_views_data()

Clear caches due to updated views data.

node_post_update_rebuild_node_revision_routes()

Rebuild the node revision routes.

node_removed_post_updates()

Implements hook_removed_post_updates().

olivero_form_system_theme_settings_alter($form, FormStateInterface $form_state)

Implements hook_form_FORM_ID_alter() for system_theme_settings.

path_post_update_create_language_content_settings()

Create the language content settings configuration object for path aliases.

path_removed_post_updates()

Implements hook_removed_post_updates().

responsive_image_post_update_recreate_dependencies()

Make responsive image formatters dependent on responsive image styles.

responsive_image_removed_post_updates()

Implements hook_removed_post_updates().

rest_post_update_161923()

Clear caches due to changes in route definitions.

rest_post_update_create_rest_resource_config_entities()

Create REST resource configuration entities.

rest_post_update_delete_settings()

Remove obsolete rest.settings configuration.

rest_post_update_resource_granularity()

Simplify method-granularity REST resource config to resource-granularity.

rest_removed_post_updates()

Implements hook_removed_post_updates().

search_post_update_block_page($sandbox = NULL)

Configures default search page for instantiated blocks.

search_post_update_reindex_after_diacritics_rule_change()

Mark everything for reindexing after diacritics removal rule change.

search_removed_post_updates()

Implements hook_removed_post_updates().

serialization_post_update_delete_settings()

Remove obsolete serialization.settings configuration.

system_post_update_add_expand_all_items_key_in_system_menu_block($sandbox = NULL)

Initialize 'expand_all_items' values to system_menu_block.

system_post_update_add_region_to_entity_displays()

Update entity displays to contain the region for each field.

system_post_update_change_action_plugins()

Change plugin IDs of actions.

system_post_update_change_delete_action_plugins()

Change plugin IDs of delete actions.

system_post_update_claro_dropbutton_variants()

Clear caches due to trustedCallbacks changing in ClaroPreRender.

system_post_update_classy_message_library()

Clear caches to ensure Classy's message library is always added.

system_post_update_clear_menu_cache()

Clear the menu cache.

system_post_update_delete_authorize_settings()

Remove obsolete system.authorize configuration.

system_post_update_delete_rss_settings()

Remove obsolete system.rss configuration.

system_post_update_enable_provider_database_driver()

Enable the modules that are providing the listed database drivers.

system_post_update_entity_reference_autocomplete_match_limit($sandbox = NULL)

Populate the new 'match_limit' setting for the ER autocomplete widget.

system_post_update_entity_revision_metadata_bc_cleanup()

Remove backwards-compatibility leftovers from entity type definitions.

system_post_update_extra_fields($sandbox = NULL)

Update all entity view displays that contain extra fields.

system_post_update_extra_fields_form_display($sandbox = NULL)

Update all entity form displays that contain extra fields.

system_post_update_field_formatter_entity_schema()

Clear caches due to schema changes in core.entity.schema.yml.

system_post_update_field_type_plugins()

Force field type plugin definitions to be cleared.

system_post_update_fix_jquery_extend()

Clear the library cache and ensure aggregate files are regenerated.

system_post_update_hashes_clear_cache()

Force caches using hashes to be cleared (Twig, render cache, etc.).

system_post_update_language_item_callback()

Force cache clear for language item callback.

system_post_update_layout_plugin_schema_change()

Clear the schema cache.

system_post_update_recalculate_configuration_entity_dependencies($sandbox = NULL)

Re-save all configuration entities to recalculate dependencies.

system_post_update_remove_key_value_expire_all_index()

Drop the 'all' index on the 'key_value_expire' table.

system_post_update_schema_version_int()

Update schema version to integers.

system_post_update_service_advisory_settings()

Add new security advisory retrieval settings.

system_post_update_sort_all_config()

Sort all configuration according to its schema.

system_post_update_states_clear_cache()

Force cache clear to ensure aggregated JavaScript files are regenerated.

system_post_update_timestamp_plugins()

Force plugin definitions to be cleared.

system_post_update_uninstall_classy()

Uninstall Classy if it is no longer needed.

system_post_update_uninstall_entity_reference_module()

Uninstall entity_reference.

system_post_update_uninstall_simpletest()

Uninstall SimpleTest.

system_post_update_uninstall_stable()

Uninstall Stable if it is no longer needed.

system_removed_post_updates()

Implements hook_removed_post_updates().

taxonomy_post_update_clear_entity_bundle_field_definitions_cache()

Clear entity_bundle_field_definitions cache for new parent field settings.

void
taxonomy_post_update_clear_views_argument_validator_plugins_cache()

Clear the cache after deprecating Term views argument validator.

taxonomy_post_update_clear_views_data_cache()

Clear caches due to updated taxonomy entity views data.

taxonomy_post_update_configure_status_field_widget($sandbox = NULL)

Add status with settings to all form displays for taxonomy entities.

taxonomy_post_update_handle_publishing_status_addition_in_views($sandbox = NULL)

Add a 'published' = TRUE filter for all Taxonomy term views and converts existing ones that were using the 'content_translation_status' field.

taxonomy_post_update_make_taxonomy_term_revisionable($sandbox)

Update taxonomy terms to be revisionable.

taxonomy_post_update_remove_hierarchy_from_vocabularies($sandbox = NULL)

Remove the 'hierarchy' property from vocabularies.

taxonomy_removed_post_updates()

Implements hook_removed_post_updates().

text_post_update_add_required_summary_flag($sandbox = NULL)

Update text_with_summary fields to add summary required flags.

text_post_update_add_required_summary_flag_form_display($sandbox = NULL)

Update text_with_summary widgets to add summary required flags.

text_removed_post_updates()

Implements hook_removed_post_updates().

tour_post_update_joyride_selectors_to_selector_property(array $sandbox = NULL)

Convert Joyride selectors to selector property.

user_post_update_enforce_order_of_permissions()

Enforce order of role permissions.

user_post_update_update_roles($sandbox = NULL)

Calculate role dependencies and remove non-existent permissions.

user_removed_post_updates()

Implements hook_removed_post_updates().

views_post_update_boolean_filter_values()

Set all boolean filter values to strings.

views_post_update_bulk_field_moved()

Update dependencies for moved bulk field plugin.

views_post_update_cleanup_duplicate_views_data()

Update some views fields that were previously duplicated.

views_post_update_configuration_entity_relationships()

Clear errors caused by relationships to configuration entities.

views_post_update_entity_link_url($sandbox = NULL)

Add additional settings to the entity link field and convert node_path usage to entity_link.

views_post_update_exposed_filter_blocks_label_display($sandbox = NULL)

Update exposed filter blocks label display to be disabled.

views_post_update_field_formatter_dependencies()

Include field formatter dependencies in a view when the formatter is used.

views_post_update_field_names_for_multivalue_fields($sandbox = NULL)

Update field names for multi-value base fields.

views_post_update_filter_placeholder_text()

Add placeholder settings to string or numeric filters.

views_post_update_grouped_filters()

Rebuild caches to ensure schema changes are read in.

views_post_update_limit_operator_defaults($sandbox = NULL)

Define default values for limit operators settings in all filters.

views_post_update_make_placeholders_translatable()

Rebuild cache to allow placeholder texts to be translatable.

views_post_update_provide_revision_table_relationship()

Clear caches due to adding a relationship from revision table to base table.

views_post_update_remove_core_key($sandbox = NULL)

Remove core key from views configuration.

views_post_update_remove_sorting_global_text_field()

Clear caches due to removal of sorting for global custom text field.

views_post_update_rename_default_display_setting()

Rename the setting for showing the default display to 'default_display'.

views_post_update_revision_metadata_fields()

Fix table names for revision metadata fields.

views_post_update_serializer_dependencies()

Fix views with serializer dependencies.

void
views_post_update_sort_identifier(array|null $sandbox = NULL)

Add the identifier option to all sort handler configurations.

views_post_update_table_display_cache_max_age($sandbox = NULL)

Fix cache max age for table displays.

views_post_update_taxonomy_index_tid()

Fix views with dependencies on taxonomy terms that don't exist.

views_post_update_title_translations()

Rebuild routes to fix view title translations.

views_post_update_update_cacheability_metadata()

Update the cacheability metadata for all views.

views_post_update_views_data_table_dependencies($sandbox = NULL)

Include views data table provider in views dependencies.

views_removed_post_updates()

Implements hook_removed_post_updates().

workspaces_post_update_access_clear_caches()

Clear caches due to access changes.

workspaces_post_update_modify_base_field_author_override()

Updates stale references to Drupal\workspaces\Entity\Workspace::getCurrentUserId.

workspaces_post_update_move_association_data($sandbox)

Move the workspace association data to an entity field and a custom table.

workspaces_post_update_remove_association_schema_data()

Removes the workspace association entity and field schema data.

workspaces_post_update_remove_default_workspace()

Remove the default workspace.

workspaces_post_update_update_deploy_form_display()

Add the workspace 'parent' field to the 'deploy' form display.

workspaces_removed_post_updates()

Implements hook_removed_post_updates().